<!DOCTYPE html>
<html lang="en-us">
  <head>

    <meta http-equiv="content-type" content="text/html; charset=utf-8">
    
<meta charset="UTF-8">
<title>Watcher settings in Elasticsearch | Elasticsearch Guide [7.7] | Elastic</title>
<link rel="home" href="index.html" title="Elasticsearch Guide [7.7]">
<link rel="up" href="settings.html" title="Configuring Elasticsearch">
<link rel="prev" href="modules-threadpool.html" title="Thread pools">
<link rel="next" href="important-settings.html" title="Important Elasticsearch configuration">
<meta name="DC.type" content="Learn/Docs/Elasticsearch/Reference/7.7">
<meta name="DC.subject" content="Elasticsearch">
<meta name="DC.identifier" content="7.7">
<meta name="robots" content="noindex,nofollow">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <script src="https://cdn.optimizely.com/js/18132920325.js"></script>
    <link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
    <link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
    <link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
    <link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
    <link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
    <link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
    <link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
    <link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
    <link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
    <link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
    <link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
    <link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
    <link rel="manifest" href="/manifest.json">
    <meta name="apple-mobile-web-app-title" content="Elastic">
    <meta name="application-name" content="Elastic">
    <meta name="msapplication-TileColor" content="#ffffff">
    <meta name="msapplication-TileImage" content="/mstile-144x144.png">
    <meta name="theme-color" content="#ffffff">
    <meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd">
    <meta name="yandex-verification" content="d8a47e95d0972434">
    <meta name="localized" content="true">
    <meta name="st:robots" content="follow,index">
    <meta property="og:image" content="https://www.elastic.co/static/images/elastic-logo-200.png">
    <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
    <link rel="icon" href="/favicon.ico" type="image/x-icon">
    <link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
    <link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
    <link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
    <link rel="stylesheet" type="text/css" href="/guide/static/styles.css">
  </head>

  <!--© 2015-2021 Elasticsearch B.V. Copying, publishing and/or distributing without written permission is strictly prohibited.-->

  <body>
    <!-- Google Tag Manager -->
    <script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
    <!-- End Google Tag Manager -->

    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());
      gtag('config', 'UA-12395217-16');
    </script>

    <!--BEGIN QUALTRICS WEBSITE FEEDBACK SNIPPET-->
    <script type="text/javascript">
      (function(){var g=function(e,h,f,g){
      this.get=function(a){for(var a=a+"=",c=document.cookie.split(";"),b=0,e=c.length;b<e;b++){for(var d=c[b];" "==d.charAt(0);)d=d.substring(1,d.length);if(0==d.indexOf(a))return d.substring(a.length,d.length)}return null};
      this.set=function(a,c){var b="",b=new Date;b.setTime(b.getTime()+6048E5);b="; expires="+b.toGMTString();document.cookie=a+"="+c+b+"; path=/; "};
      this.check=function(){var a=this.get(f);if(a)a=a.split(":");else if(100!=e)"v"==h&&(e=Math.random()>=e/100?0:100),a=[h,e,0],this.set(f,a.join(":"));else return!0;var c=a[1];if(100==c)return!0;switch(a[0]){case "v":return!1;case "r":return c=a[2]%Math.floor(100/c),a[2]++,this.set(f,a.join(":")),!c}return!0};
      this.go=function(){if(this.check()){var a=document.createElement("script");a.type="text/javascript";a.src=g;document.body&&document.body.appendChild(a)}};
      this.start=function(){var a=this;window.addEventListener?window.addEventListener("load",function(){a.go()},!1):window.attachEvent&&window.attachEvent("onload",function(){a.go()})}};
      try{(new g(100,"r","QSI_S_ZN_emkP0oSe9Qrn7kF","https://znemkp0ose9qrn7kf-elastic.siteintercept.qualtrics.com/WRSiteInterceptEngine/?Q_ZID=ZN_emkP0oSe9Qrn7kF")).start()}catch(i){}})();
    </script><div id="ZN_emkP0oSe9Qrn7kF"><!--DO NOT REMOVE-CONTENTS PLACED HERE--></div>
    <!--END WEBSITE FEEDBACK SNIPPET-->

    <div id="elastic-nav" style="display:none;"></div>
    <script src="https://www.elastic.co/elastic-nav.js"></script>

    <!-- Subnav -->
    <div>
      <div>
        <div class="tertiary-nav d-none d-md-block">
          <div class="container">
            <div class="p-t-b-15 d-flex justify-content-between nav-container">
              <div class="breadcrum-wrapper"><span><a href="/guide/" style="font-size: 14px; font-weight: 600; color: #000;">Docs</a></span></div>
            </div>
          </div>
        </div>
      </div>
    </div>

    <div class="main-container">
      <section id="content">
        <div class="content-wrapper">

          <section id="guide" lang="en">
            <div class="container">
              <div class="row">
                <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                  <!-- start body -->
                  <div class="page_header">
<strong>IMPORTANT</strong>: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
<a href="../current/index.html">current release documentation</a>.
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="setup.html">Set up Elasticsearch</a></span>
»
<span class="breadcrumb-link"><a href="settings.html">Configuring Elasticsearch</a></span>
»
<span class="breadcrumb-node">Watcher settings in Elasticsearch</span>
</div>
<div class="navheader">
<span class="prev">
<a href="modules-threadpool.html">« Thread pools</a>
</span>
<span class="next">
<a href="important-settings.html">Important Elasticsearch configuration »</a>
</span>
</div>
<div class="section xpack">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="notification-settings"></a>Watcher settings in Elasticsearch<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/settings/notification-settings.asciidoc">edit</a><a class="xpack_tag" href="/subscriptions"></a>
</h2>
</div></div></div>

<p>You configure Watcher settings to set up Watcher and send notifications via
<a class="xref" href="notification-settings.html#email-notification-settings" title="Email Notification Settings">email</a>,
<a class="xref" href="notification-settings.html#slack-notification-settings" title="Slack Notification Settings">Slack</a>, and
<a class="xref" href="notification-settings.html#pagerduty-notification-settings" title="PagerDuty Notification Settings">PagerDuty</a>.</p>
<p>All of these settings can be added to the <code class="literal">elasticsearch.yml</code> configuration file,
with the exception of the secure settings, which you add to the Elasticsearch keystore.
For more information about creating and updating the Elasticsearch keystore, see
<a class="xref" href="secure-settings.html" title="Secure settings">Secure settings</a>. Dynamic settings can also be updated across a cluster with the
<a class="xref" href="cluster-update-settings.html" title="Cluster update settings API">cluster update settings API</a>.</p>
<h4>
<a id="general-notification-settings"></a>General Watcher Settings<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/settings/notification-settings.asciidoc">edit</a>
</h4>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">xpack.watcher.enabled</code>
</span>
</dt>
<dd>
Set to <code class="literal">false</code> to disable Watcher on the node.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.watcher.encrypt_sensitive_data</code>
</span>
</dt>
<dd>
Set to <code class="literal">true</code> to encrypt sensitive data. If this setting is enabled, you
must also specify the <code class="literal">xpack.watcher.encryption_key</code> setting. For more
information, see <a class="xref" href="encrypting-data.html" title="Encrypting sensitive data in Watcher"><em>Encrypting sensitive data in Watcher</em></a>.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.watcher.encryption_key</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
Specifies the path to a file that contains a key for encrypting sensitive data.
If <code class="literal">xpack.watcher.encrypt_sensitive_data</code> is set to <code class="literal">true</code>, this setting is
required. For more information, see <a class="xref" href="encrypting-data.html" title="Encrypting sensitive data in Watcher"><em>Encrypting sensitive data in Watcher</em></a>.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.watcher.history.cleaner_service.enabled</code>
</span>
</dt>
<dd>
<p>
<span class="Admonishment Admonishment--change">
[<span class="Admonishment-version u-mono">6.3.0</span>]
<span class="Admonishment-detail">
Added in 6.3.0. Default changed to <code class="literal">true</code>.
</span>
</span>
<span class="Admonishment Admonishment--change">
[<span class="Admonishment-version u-mono u-strikethrough">7.0.0</span>]
<span class="Admonishment-detail">
Deprecated in 7.0.0. Watcher history indices are now managed by the <code class="literal">watch-history-ilm-policy</code> ILM policy
</span>
</span>
</p>
<p>Set to <code class="literal">true</code> (default) to enable the cleaner service. If this setting is
<code class="literal">true</code>, the <code class="literal">xpack.monitoring.enabled</code> setting must also be set to <code class="literal">true</code> with
a local exporter enabled. The cleaner service removes previous versions of
Watcher indices (for example, <code class="literal">.watcher-history*</code>) when it determines that
they are old. The duration of Watcher indices is determined by the
<code class="literal">xpack.monitoring.history.duration</code> setting, which defaults to 7 days. For
more information about that setting, see <a class="xref" href="monitoring-settings.html" title="Monitoring settings in Elasticsearch">Monitoring settings</a>.</p>
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.proxy.host</code>
</span>
</dt>
<dd>
Specifies the address of the proxy server to use to connect to HTTP services.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.proxy.port</code>
</span>
</dt>
<dd>
Specifies the port number to use to connect to the proxy server.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.default_connection_timeout</code>
</span>
</dt>
<dd>
The maximum period to wait until abortion of the request, when a
connection is being initiated.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.default_read_timeout</code>
</span>
</dt>
<dd>
The maximum period of inactivity between two data packets, before the
request is aborted.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.max_response_size</code>
</span>
</dt>
<dd>
Specifies the maximum size an HTTP response is allowed to have, defaults to
<code class="literal">10mb</code>, the maximum configurable value is <code class="literal">50mb</code>.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.whitelist</code>
</span>
</dt>
<dd>
A list of URLs, that the internal HTTP client is allowed to connect to. This
client is used in the HTTP input, the webhook, the slack, pagerduty,
and jira actions. This setting can be updated dynamically.  It defaults to <code class="literal">*</code>
allowing everything. Note: If you configure this setting and you are using one
of the slack/pagerduty actions, you have to ensure that the
corresponding endpoints are explicitly allowed as well.
</dd>
</dl>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ssl-notification-settings"></a>Watcher HTTP TLS/SSL settings<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/settings/ssl-settings.asciidoc">edit</a>
</h3>
</div></div></div>
<p>You can configure the following TLS/SSL settings.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.supported_protocols</code>
</span>
</dt>
<dd>
<p>
Supported protocols with versions. Valid protocols: <code class="literal">SSLv2Hello</code>,
<code class="literal">SSLv3</code>, <code class="literal">TLSv1</code>, <code class="literal">TLSv1.1</code>, <code class="literal">TLSv1.2</code>, <code class="literal">TLSv1.3</code>. If the JVM’s SSL provider supports TLSv1.3,
the default is <code class="literal">TLSv1.3,TLSv1.2,TLSv1.1</code>. Otherwise, the default is
<code class="literal">TLSv1.2,TLSv1.1</code>.
</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>If <code class="literal">xpack.security.fips_mode.enabled</code> is <code class="literal">true</code>, you cannot use <code class="literal">SSLv2Hello</code>
or <code class="literal">SSLv3</code>. See <a class="xref" href="fips-140-compliance.html" title="FIPS 140-2">FIPS 140-2</a>.</p>
</div>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.verification_mode</code>
</span>
</dt>
<dd>
<p>
Controls the verification of certificates.
Valid values are:
</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<code class="literal">full</code>, which verifies that the provided certificate is signed by a trusted
authority (CA) and also verifies that the server’s hostname (or IP address)
matches the names identified within the certificate.
</li>
<li class="listitem">
<code class="literal">certificate</code>, which verifies that the provided certificate is signed by a
trusted authority (CA), but does not perform any hostname verification.
</li>
<li class="listitem">
<p><code class="literal">none</code>, which performs <em>no verification</em> of the server’s certificate. This
mode disables many of the security benefits of SSL/TLS and should only be used
after very careful consideration. It is primarily intended as a temporary
diagnostic mechanism when attempting to resolve TLS errors; its use on
production clusters is strongly discouraged.</p>
<p>The default value is <code class="literal">full</code>.</p>
</li>
</ul>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.cipher_suites</code>
</span>
</dt>
<dd>
<p>
Supported cipher suites vary depending on which version of Java you use. For
example, for version 11 the default value is <code class="literal">TLS_AES_256_GCM_SHA384</code>,
<code class="literal">TLS_AES_128_GCM_SHA256</code>, <code class="literal">TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</code>,
<code class="literal">TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</code>, <code class="literal">TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384</code>,
<code class="literal">TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256</code>, <code class="literal">TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384</code>,
<code class="literal">TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256</code>, <code class="literal">TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384</code>,
<code class="literal">TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256</code>, <code class="literal">TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA</code>,
<code class="literal">TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA</code>, <code class="literal">TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA</code>,
<code class="literal">TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA</code>, <code class="literal">TLS_RSA_WITH_AES_256_GCM_SHA384</code>,
<code class="literal">TLS_RSA_WITH_AES_128_GCM_SHA256</code>, <code class="literal">TLS_RSA_WITH_AES_256_CBC_SHA256</code>,
<code class="literal">TLS_RSA_WITH_AES_128_CBC_SHA256</code>, <code class="literal">TLS_RSA_WITH_AES_256_CBC_SHA</code>,
<code class="literal">TLS_RSA_WITH_AES_128_CBC_SHA</code>.
</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>The default cipher suites list above includes TLSv1.3 ciphers and ciphers
that require the <em>Java Cryptography Extension (JCE) Unlimited Strength
Jurisdiction Policy Files</em> for 256-bit AES encryption. If TLSv1.3 is not
available, the TLSv1.3 ciphers <code class="literal">TLS_AES_256_GCM_SHA384</code> and
<code class="literal">TLS_AES_128_GCM_SHA256</code> are not included in the default list. If 256-bit AES is
unavailable, ciphers with <code class="literal">AES_256</code> in their names are not included in the
default list. Finally, AES GCM has known performance issues in Java versions
prior to 11 and is included in the default list only when using Java 11 or above.</p>
</div>
</div>
<p>For more information, see Oracle’s
<a href="https://docs.oracle.com/en/java/javase/11/security/oracle-providers.html#GUID-7093246A-31A3-4304-AC5F-5FB6400405E2" class="ulink" target="_top">Java Cryptography Architecture documentation</a>.</p>
</dd>
</dl>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="watcher-tls-ssl-key-trusted-certificate-settings"></a>Watcher HTTP TLS/SSL key and trusted certificate settings<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/settings/ssl-settings.asciidoc">edit</a>
</h4>
</div></div></div>
<p>The following settings are used to specify a private key, certificate, and the
trusted certificates that should be used when communicating over an SSL/TLS connection.
A private key and certificate are optional and would be used if the server requires client authentication for PKI
authentication.</p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="_pem_encoded_files_4"></a>PEM encoded files<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/settings/ssl-settings.asciidoc">edit</a>
</h4>
</div></div></div>
<p>When using PEM encoded files, use the following settings:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.key</code>
</span>
</dt>
<dd>
Path to a PEM encoded file containing the private key.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.key_passphrase</code>
</span>
</dt>
<dd>
The passphrase that is used to decrypt the private key. Since the key might not
be encrypted, this value is optional.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.secure_key_passphrase</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
The passphrase that is used to decrypt the private key. Since the key might not
be encrypted, this value is optional.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.certificate</code>
</span>
</dt>
<dd>
Specifies the path for the PEM encoded certificate (or certificate chain) that is
associated with the key.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.certificate_authorities</code>
</span>
</dt>
<dd>
List of paths to PEM encoded certificate files that should be trusted.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="_java_keystore_files_4"></a>Java keystore files<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/settings/ssl-settings.asciidoc">edit</a>
</h4>
</div></div></div>
<p>When using Java keystore files (JKS), which contain the private key, certificate
and certificates that should be trusted, use the following settings:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.keystore.path</code>
</span>
</dt>
<dd>
The path for the keystore file that contains a private key and certificate.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.keystore.password</code>
</span>
</dt>
<dd>
The password for the keystore.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.keystore.secure_password</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
The password for the keystore.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.keystore.key_password</code>
</span>
</dt>
<dd>
The password for the key in the keystore. The default is the keystore password.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.keystore.secure_key_password</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
The password for the key in the keystore. The default is the keystore password.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.truststore.path</code>
</span>
</dt>
<dd>
The path for the keystore that contains the certificates to trust. It must be
either a Java keystore (jks) or a PKCS#12 file.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.truststore.password</code>
</span>
</dt>
<dd>
The password for the truststore.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.truststore.secure_password</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
Password for the truststore.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="watcher-pkcs12-files"></a>PKCS#12 files<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/settings/ssl-settings.asciidoc">edit</a>
</h4>
</div></div></div>
<p>Elasticsearch can be configured to use PKCS#12 container files (<code class="literal">.p12</code> or <code class="literal">.pfx</code> files)
that contain the private key, certificate and certificates that should be trusted.</p>
<p>PKCS#12 files are configured in the same way as Java keystore files:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.keystore.path</code>
</span>
</dt>
<dd>
The path for the keystore file that contains a private key and certificate.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.keystore.type</code>
</span>
</dt>
<dd>
The format of the keystore file. It must be either <code class="literal">jks</code> or <code class="literal">PKCS12</code>. If the
keystore path ends in ".p12", ".pfx", or ".pkcs12", this setting defaults
to <code class="literal">PKCS12</code>. Otherwise, it defaults to <code class="literal">jks</code>.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.keystore.password</code>
</span>
</dt>
<dd>
The password for the keystore.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.keystore.secure_password</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
The password for the keystore.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.keystore.key_password</code>
</span>
</dt>
<dd>
The password for the key in the keystore. The default is the keystore password.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.keystore.secure_key_password</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
The password for the key in the keystore. The default is the keystore password.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.truststore.path</code>
</span>
</dt>
<dd>
The path for the keystore that contains the certificates to trust. It must be
either a Java keystore (jks) or a PKCS#12 file.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.truststore.type</code>
</span>
</dt>
<dd>
Set this to <code class="literal">PKCS12</code> to indicate that the truststore is a PKCS#12 file.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.truststore.password</code>
</span>
</dt>
<dd>
The password for the truststore.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.ssl.truststore.secure_password</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
Password for the truststore.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="watcher-pkcs11-tokens"></a>PKCS#11 tokens<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/settings/ssl-settings.asciidoc">edit</a>
</h4>
</div></div></div>
<p>Elasticsearch can be configured to use a PKCS#11 token that contains the private key,
certificate and certificates that should be trusted.</p>
<p>PKCS#11 token require additional configuration on the JVM level and can be enabled
via the following settings:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">xpack.http.keystore.type</code>
</span>
</dt>
<dd>
Set this to <code class="literal">PKCS11</code> to indicate that the PKCS#11 token should be used as a keystore.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.http.truststore.type</code>
</span>
</dt>
<dd>
The format of the truststore file. For the Java keystore format, use <code class="literal">jks</code>. For
PKCS#12 files, use <code class="literal">PKCS12</code>. For a PKCS#11 token, use <code class="literal">PKCS11</code>. The default is
<code class="literal">jks</code>.
</dd>
</dl>
</div>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>When configuring the PKCS#11 token that your JVM is configured to use as
a keystore or a truststore for Elasticsearch, the PIN for the token can be
configured by setting the appropriate value to <code class="literal">ssl.truststore.password</code>
or <code class="literal">ssl.truststore.secure_password</code> in the context that you are configuring.
Since there can only be one PKCS#11 token configured, only one keystore and
truststore will be usable for configuration in Elasticsearch. This in turn means
that only one certificate can be used for TLS both in the transport and the
http layer.</p>
</div>
</div>
<h4>
<a id="email-notification-settings"></a>Email Notification Settings<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/settings/notification-settings.asciidoc">edit</a>
</h4>
<p>You can configure the following email notification settings in
<code class="literal">elasticsearch.yml</code>. For more information about sending notifications
via email, see <a class="xref" href="actions-email.html#configuring-email-actions" title="Configuring email actions">Configuring email actions</a>.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">xpack.notification.email.account</code>
</span>
</dt>
<dd>
<p>
Specifies account information for sending notifications via email. You
can specify the following email account attributes:
</p>
<div class="variablelist">
<a id="email-account-attributes"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">profile</code> (<a class="xref" href="cluster-update-settings.html" title="Cluster update settings API">Dynamic</a>)
</span>
</dt>
<dd>
The <a class="xref" href="actions-email.html#configuring-email" title="Configuring email accounts">email profile</a> to use to build the MIME
messages that are sent from the account. Valid values: <code class="literal">standard</code>, <code class="literal">gmail</code> and
<code class="literal">outlook</code>. Defaults to <code class="literal">standard</code>.
</dd>
<dt>
<span class="term">
<code class="literal">email_defaults.*</code> (<a class="xref" href="cluster-update-settings.html" title="Cluster update settings API">Dynamic</a>)
</span>
</dt>
<dd>
An optional set of email attributes to use as defaults
for the emails sent from the account. See
<a class="xref" href="actions-email.html#email-action-attributes" title="Email action attributes">Email action attributes</a> for the supported
attributes.
</dd>
<dt>
<span class="term">
<code class="literal">smtp.auth</code> (<a class="xref" href="cluster-update-settings.html" title="Cluster update settings API">Dynamic</a>)
</span>
</dt>
<dd>
Set to <code class="literal">true</code> to attempt to authenticate the user using the
AUTH command. Defaults to <code class="literal">false</code>.
</dd>
<dt>
<span class="term">
<code class="literal">smtp.host</code> (<a class="xref" href="cluster-update-settings.html" title="Cluster update settings API">Dynamic</a>)
</span>
</dt>
<dd>
The SMTP server to connect to. Required.
</dd>
<dt>
<span class="term">
<code class="literal">smtp.port</code> (<a class="xref" href="cluster-update-settings.html" title="Cluster update settings API">Dynamic</a>)
</span>
</dt>
<dd>
The SMTP server port to connect to. Defaults to 25.
</dd>
<dt>
<span class="term">
<code class="literal">smtp.user</code> (<a class="xref" href="cluster-update-settings.html" title="Cluster update settings API">Dynamic</a>)
</span>
</dt>
<dd>
The user name for SMTP. Required.
</dd>
<dt>
<span class="term">
<code class="literal">smtp.secure_password</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
The password for the specified SMTP user.
</dd>
<dt>
<span class="term">
<code class="literal">smtp.starttls.enable</code> (<a class="xref" href="cluster-update-settings.html" title="Cluster update settings API">Dynamic</a>)
</span>
</dt>
<dd>
Set to <code class="literal">true</code> to enable the use of the <code class="literal">STARTTLS</code>
command (if supported by the server) to switch the connection to a
TLS-protected connection before issuing any login commands. Note that
an appropriate trust store must configured so that the client will
trust the server’s certificate. Defaults to <code class="literal">false</code>.
</dd>
<dt>
<span class="term">
<code class="literal">smtp.starttls.required</code> (<a class="xref" href="cluster-update-settings.html" title="Cluster update settings API">Dynamic</a>)
</span>
</dt>
<dd>
If <code class="literal">true</code>, then <code class="literal">STARTTLS</code> will be required. If that command fails, the
connection will fail. Defaults to <code class="literal">false</code>.
</dd>
<dt>
<span class="term">
<code class="literal">smtp.ssl.trust</code> (<a class="xref" href="cluster-update-settings.html" title="Cluster update settings API">Dynamic</a>)
</span>
</dt>
<dd>
A list of SMTP server hosts that are assumed trusted and for which
certificate verification is disabled. If set to "*", all hosts are
trusted. If set to a whitespace separated list of hosts, those hosts
are trusted. Otherwise, trust depends on the certificate the server
presents.
</dd>
<dt>
<span class="term">
<code class="literal">smtp.timeout</code> (<a class="xref" href="cluster-update-settings.html" title="Cluster update settings API">Dynamic</a>)
</span>
</dt>
<dd>
The socket read timeout. Default is two minutes.
</dd>
<dt>
<span class="term">
<code class="literal">smtp.connection_timeout</code> (<a class="xref" href="cluster-update-settings.html" title="Cluster update settings API">Dynamic</a>)
</span>
</dt>
<dd>
The socket connection timeout. Default is two minutes.
</dd>
<dt>
<span class="term">
<code class="literal">smtp.write_timeout</code> (<a class="xref" href="cluster-update-settings.html" title="Cluster update settings API">Dynamic</a>)
</span>
</dt>
<dd>
The socket write timeout. Default is two minutes.
</dd>
<dt>
<span class="term">
<code class="literal">smtp.local_address</code> (<a class="xref" href="cluster-update-settings.html" title="Cluster update settings API">Dynamic</a>)
</span>
</dt>
<dd>
A configurable local address when sending emails. Not configured by default.
</dd>
<dt>
<span class="term">
<code class="literal">smtp.local_port</code> (<a class="xref" href="cluster-update-settings.html" title="Cluster update settings API">Dynamic</a>)
</span>
</dt>
<dd>
A configurable local port when sending emails. Not configured by default.
</dd>
<dt>
<span class="term">
<code class="literal">smtp.send_partial</code> (<a class="xref" href="cluster-update-settings.html" title="Cluster update settings API">Dynamic</a>)
</span>
</dt>
<dd>
Send an email, despite one of the receiver addresses being invalid.
</dd>
<dt>
<span class="term">
<code class="literal">smtp.wait_on_quit</code> (<a class="xref" href="cluster-update-settings.html" title="Cluster update settings API">Dynamic</a>)
</span>
</dt>
<dd>
If set to false the QUIT command is sent and the connection closed. If set to
true, the QUIT command is sent and a reply is waited for. True by default.
</dd>
</dl>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.html.sanitization.allow</code>
</span>
</dt>
<dd>
<p>
Specifies the HTML elements that are allowed in email notifications. For
more information, see
<a class="xref" href="actions-email.html#email-html-sanitization" title="Configuring HTML sanitization options">Configuring HTML sanitization options</a>. You can
specify individual HTML elements and the following HTML feature groups:
</p>
<div class="variablelist">
<a id="html-feature-groups"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">_tables</code>
</span>
</dt>
<dd>
All table related elements: <code class="literal">&lt;table&gt;</code>, <code class="literal">&lt;th&gt;</code>, <code class="literal">&lt;tr&gt;</code>
                    and <code class="literal">&lt;td&gt;</code>.
</dd>
<dt>
<span class="term">
<code class="literal">_blocks</code>
</span>
</dt>
<dd>
The following block elements: <code class="literal">&lt;p&gt;</code>, <code class="literal">&lt;div&gt;</code>, <code class="literal">&lt;h1&gt;</code>,
                    <code class="literal">&lt;h2&gt;</code>, <code class="literal">&lt;h3&gt;</code>, <code class="literal">&lt;h4&gt;</code>, <code class="literal">&lt;h5&gt;</code>, <code class="literal">&lt;h6&gt;</code>, <code class="literal">&lt;ul&gt;</code>, <code class="literal">&lt;ol&gt;</code>,
                    <code class="literal">&lt;li&gt;</code>, and <code class="literal">&lt;blockquote&gt;</code>.
</dd>
<dt>
<span class="term">
<code class="literal">_formatting</code>
</span>
</dt>
<dd>
The following inline formatting elements: <code class="literal">&lt;b&gt;</code>, <code class="literal">&lt;i&gt;</code>,
                    <code class="literal">&lt;s&gt;</code>, <code class="literal">&lt;u&gt;</code>, <code class="literal">&lt;o&gt;</code>, <code class="literal">&lt;sup&gt;</code>, <code class="literal">&lt;sub&gt;</code>, <code class="literal">&lt;ins&gt;</code>, <code class="literal">&lt;del&gt;</code>,
                    <code class="literal">&lt;strong&gt;</code>, <code class="literal">&lt;strike&gt;</code>, <code class="literal">&lt;tt&gt;</code>, <code class="literal">&lt;code&gt;</code>, <code class="literal">&lt;big&gt;</code>,
                    <code class="literal">&lt;small&gt;</code>, <code class="literal">&lt;br&gt;</code>, <code class="literal">&lt;span&gt;</code>, and <code class="literal">&lt;em&gt;</code>.
</dd>
<dt>
<span class="term">
<code class="literal">_links</code>
</span>
</dt>
<dd>
The <code class="literal">&lt;a&gt;</code> element with an <code class="literal">href</code> attribute that points
                    to a URL using the following protocols: <code class="literal">http</code>, <code class="literal">https</code>
                    and <code class="literal">mailto</code>.
</dd>
<dt>
<span class="term">
<code class="literal">_styles</code>
</span>
</dt>
<dd>
The <code class="literal">style</code> attribute on all elements. Note that CSS
                    attributes are also sanitized to prevent XSS attacks.
</dd>
<dt>
<span class="term">
<code class="literal">img</code>
</span>
</dt>
<dt>
<span class="term">
<code class="literal">img:all</code>
</span>
</dt>
<dd>
All images (external and embedded).
</dd>
<dt>
<span class="term">
<code class="literal">img:embedded</code>
</span>
</dt>
<dd>
Only embedded images. Embedded images can only use the
                  <code class="literal">cid:</code> URL protocol in their <code class="literal">src</code> attribute.
</dd>
</dl>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.html.sanitization.disallow</code>
</span>
</dt>
<dd>
Specifies the HTML elements that are NOT allowed in email notifications.
You can specify individual HTML elements and <a class="xref" href="notification-settings.html#html-feature-groups">HTML feature groups</a>.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.html.sanitization.enabled</code>
</span>
</dt>
<dd>
Set to <code class="literal">false</code> to completely disable HTML sanitation. Not recommended.
Defaults to <code class="literal">true</code>.
</dd>
</dl>
</div>
</div>

</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ssl-notification-smtp-settings"></a>Watcher Email TLS/SSL settings<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/settings/ssl-settings.asciidoc">edit</a>
</h3>
</div></div></div>
<p>You can configure the following TLS/SSL settings.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.supported_protocols</code>
</span>
</dt>
<dd>
<p>
Supported protocols with versions. Valid protocols: <code class="literal">SSLv2Hello</code>,
<code class="literal">SSLv3</code>, <code class="literal">TLSv1</code>, <code class="literal">TLSv1.1</code>, <code class="literal">TLSv1.2</code>, <code class="literal">TLSv1.3</code>. If the JVM’s SSL provider supports TLSv1.3,
the default is <code class="literal">TLSv1.3,TLSv1.2,TLSv1.1</code>. Otherwise, the default is
<code class="literal">TLSv1.2,TLSv1.1</code>.
</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>If <code class="literal">xpack.security.fips_mode.enabled</code> is <code class="literal">true</code>, you cannot use <code class="literal">SSLv2Hello</code>
or <code class="literal">SSLv3</code>. See <a class="xref" href="fips-140-compliance.html" title="FIPS 140-2">FIPS 140-2</a>.</p>
</div>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.verification_mode</code>
</span>
</dt>
<dd>
<p>
Controls the verification of certificates.
Valid values are:
</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<code class="literal">full</code>, which verifies that the provided certificate is signed by a trusted
authority (CA) and also verifies that the server’s hostname (or IP address)
matches the names identified within the certificate.
</li>
<li class="listitem">
<code class="literal">certificate</code>, which verifies that the provided certificate is signed by a
trusted authority (CA), but does not perform any hostname verification.
</li>
<li class="listitem">
<p><code class="literal">none</code>, which performs <em>no verification</em> of the server’s certificate. This
mode disables many of the security benefits of SSL/TLS and should only be used
after very careful consideration. It is primarily intended as a temporary
diagnostic mechanism when attempting to resolve TLS errors; its use on
production clusters is strongly discouraged.</p>
<p>The default value is <code class="literal">full</code>.</p>
</li>
</ul>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.cipher_suites</code>
</span>
</dt>
<dd>
<p>
Supported cipher suites vary depending on which version of Java you use. For
example, for version 11 the default value is <code class="literal">TLS_AES_256_GCM_SHA384</code>,
<code class="literal">TLS_AES_128_GCM_SHA256</code>, <code class="literal">TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</code>,
<code class="literal">TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</code>, <code class="literal">TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384</code>,
<code class="literal">TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256</code>, <code class="literal">TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384</code>,
<code class="literal">TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256</code>, <code class="literal">TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384</code>,
<code class="literal">TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256</code>, <code class="literal">TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA</code>,
<code class="literal">TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA</code>, <code class="literal">TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA</code>,
<code class="literal">TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA</code>, <code class="literal">TLS_RSA_WITH_AES_256_GCM_SHA384</code>,
<code class="literal">TLS_RSA_WITH_AES_128_GCM_SHA256</code>, <code class="literal">TLS_RSA_WITH_AES_256_CBC_SHA256</code>,
<code class="literal">TLS_RSA_WITH_AES_128_CBC_SHA256</code>, <code class="literal">TLS_RSA_WITH_AES_256_CBC_SHA</code>,
<code class="literal">TLS_RSA_WITH_AES_128_CBC_SHA</code>.
</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>The default cipher suites list above includes TLSv1.3 ciphers and ciphers
that require the <em>Java Cryptography Extension (JCE) Unlimited Strength
Jurisdiction Policy Files</em> for 256-bit AES encryption. If TLSv1.3 is not
available, the TLSv1.3 ciphers <code class="literal">TLS_AES_256_GCM_SHA384</code> and
<code class="literal">TLS_AES_128_GCM_SHA256</code> are not included in the default list. If 256-bit AES is
unavailable, ciphers with <code class="literal">AES_256</code> in their names are not included in the
default list. Finally, AES GCM has known performance issues in Java versions
prior to 11 and is included in the default list only when using Java 11 or above.</p>
</div>
</div>
<p>For more information, see Oracle’s
<a href="https://docs.oracle.com/en/java/javase/11/security/oracle-providers.html#GUID-7093246A-31A3-4304-AC5F-5FB6400405E2" class="ulink" target="_top">Java Cryptography Architecture documentation</a>.</p>
</dd>
</dl>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="watcher-email-tls-ssl-key-trusted-certificate-settings"></a>Watcher Email TLS/SSL key and trusted certificate settings<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/settings/ssl-settings.asciidoc">edit</a>
</h4>
</div></div></div>
<p>The following settings are used to specify a private key, certificate, and the
trusted certificates that should be used when communicating over an SSL/TLS connection.
A private key and certificate are optional and would be used if the server requires client authentication for PKI
authentication.</p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="_pem_encoded_files_5"></a>PEM encoded files<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/settings/ssl-settings.asciidoc">edit</a>
</h4>
</div></div></div>
<p>When using PEM encoded files, use the following settings:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.key</code>
</span>
</dt>
<dd>
Path to a PEM encoded file containing the private key.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.key_passphrase</code>
</span>
</dt>
<dd>
The passphrase that is used to decrypt the private key. Since the key might not
be encrypted, this value is optional.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.secure_key_passphrase</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
The passphrase that is used to decrypt the private key. Since the key might not
be encrypted, this value is optional.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.certificate</code>
</span>
</dt>
<dd>
Specifies the path for the PEM encoded certificate (or certificate chain) that is
associated with the key.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.certificate_authorities</code>
</span>
</dt>
<dd>
List of paths to PEM encoded certificate files that should be trusted.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="_java_keystore_files_5"></a>Java keystore files<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/settings/ssl-settings.asciidoc">edit</a>
</h4>
</div></div></div>
<p>When using Java keystore files (JKS), which contain the private key, certificate
and certificates that should be trusted, use the following settings:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.keystore.path</code>
</span>
</dt>
<dd>
The path for the keystore file that contains a private key and certificate.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.keystore.password</code>
</span>
</dt>
<dd>
The password for the keystore.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.keystore.secure_password</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
The password for the keystore.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.keystore.key_password</code>
</span>
</dt>
<dd>
The password for the key in the keystore. The default is the keystore password.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.keystore.secure_key_password</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
The password for the key in the keystore. The default is the keystore password.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.truststore.path</code>
</span>
</dt>
<dd>
The path for the keystore that contains the certificates to trust. It must be
either a Java keystore (jks) or a PKCS#12 file.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.truststore.password</code>
</span>
</dt>
<dd>
The password for the truststore.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.truststore.secure_password</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
Password for the truststore.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="watcher-email-pkcs12-files"></a>PKCS#12 files<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/settings/ssl-settings.asciidoc">edit</a>
</h4>
</div></div></div>
<p>Elasticsearch can be configured to use PKCS#12 container files (<code class="literal">.p12</code> or <code class="literal">.pfx</code> files)
that contain the private key, certificate and certificates that should be trusted.</p>
<p>PKCS#12 files are configured in the same way as Java keystore files:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.keystore.path</code>
</span>
</dt>
<dd>
The path for the keystore file that contains a private key and certificate.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.keystore.type</code>
</span>
</dt>
<dd>
The format of the keystore file. It must be either <code class="literal">jks</code> or <code class="literal">PKCS12</code>. If the
keystore path ends in ".p12", ".pfx", or ".pkcs12", this setting defaults
to <code class="literal">PKCS12</code>. Otherwise, it defaults to <code class="literal">jks</code>.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.keystore.password</code>
</span>
</dt>
<dd>
The password for the keystore.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.keystore.secure_password</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
The password for the keystore.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.keystore.key_password</code>
</span>
</dt>
<dd>
The password for the key in the keystore. The default is the keystore password.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.keystore.secure_key_password</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
The password for the key in the keystore. The default is the keystore password.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.truststore.path</code>
</span>
</dt>
<dd>
The path for the keystore that contains the certificates to trust. It must be
either a Java keystore (jks) or a PKCS#12 file.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.truststore.type</code>
</span>
</dt>
<dd>
Set this to <code class="literal">PKCS12</code> to indicate that the truststore is a PKCS#12 file.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.truststore.password</code>
</span>
</dt>
<dd>
The password for the truststore.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.ssl.truststore.secure_password</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
Password for the truststore.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="watcher-email-pkcs11-tokens"></a>PKCS#11 tokens<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/settings/ssl-settings.asciidoc">edit</a>
</h4>
</div></div></div>
<p>Elasticsearch can be configured to use a PKCS#11 token that contains the private key,
certificate and certificates that should be trusted.</p>
<p>PKCS#11 token require additional configuration on the JVM level and can be enabled
via the following settings:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">xpack.notification.email.keystore.type</code>
</span>
</dt>
<dd>
Set this to <code class="literal">PKCS11</code> to indicate that the PKCS#11 token should be used as a keystore.
</dd>
<dt>
<span class="term">
<code class="literal">xpack.notification.email.truststore.type</code>
</span>
</dt>
<dd>
The format of the truststore file. For the Java keystore format, use <code class="literal">jks</code>. For
PKCS#12 files, use <code class="literal">PKCS12</code>. For a PKCS#11 token, use <code class="literal">PKCS11</code>. The default is
<code class="literal">jks</code>.
</dd>
</dl>
</div>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>When configuring the PKCS#11 token that your JVM is configured to use as
a keystore or a truststore for Elasticsearch, the PIN for the token can be
configured by setting the appropriate value to <code class="literal">ssl.truststore.password</code>
or <code class="literal">ssl.truststore.secure_password</code> in the context that you are configuring.
Since there can only be one PKCS#11 token configured, only one keystore and
truststore will be usable for configuration in Elasticsearch. This in turn means
that only one certificate can be used for TLS both in the transport and the
http layer.</p>
</div>
</div>
<h4>
<a id="slack-notification-settings"></a>Slack Notification Settings<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/settings/notification-settings.asciidoc">edit</a>
</h4>
<p>You can configure the following Slack notification settings in
<code class="literal">elasticsearch.yml</code>. For more information about sending notifications
via Slack, see <a class="xref" href="actions-slack.html#configuring-slack-actions" title="Configuring Slack actions">Configuring Slack actions</a>.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">xpack.notification.slack</code>
</span>
</dt>
<dd>
<p>
Specifies account information for sending notifications
via Slack. You can specify the following Slack account attributes:
</p>
<div class="variablelist">
<a id="slack-account-attributes"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">secure_url</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
The Incoming Webhook URL to use to post messages to Slack. Required.
</dd>
<dt>
<span class="term">
<code class="literal">message_defaults.from</code>
</span>
</dt>
<dd>
The sender name to display in the
                                  Slack message. Defaults to the watch ID.
</dd>
<dt>
<span class="term">
<code class="literal">message_defaults.to</code>
</span>
</dt>
<dd>
The default Slack channels or groups you
                                           want to send messages to.
</dd>
<dt>
<span class="term">
<code class="literal">message_defaults.icon</code>
</span>
</dt>
<dd>
The icon to display in the Slack messages.
                                           Overrides the incoming webhook’s configured
                                           icon. Accepts a public URL to an image.
</dd>
<dt>
<span class="term">
<code class="literal">message_defaults.text</code>
</span>
</dt>
<dd>
The default message content.
</dd>
<dt>
<span class="term">
<code class="literal">message_defaults.attachment</code>
</span>
</dt>
<dd>
Default message attachments. Slack message attachments
                                  enable you to create more richly-formatted messages.
                                  Specified as an array as defined in the
                                  <a href="https://api.slack.com/docs/attachments" class="ulink" target="_top">
                                 Slack attachments documentation</a>.
</dd>
</dl>
</div>
</dd>
</dl>
</div>
<h4>
<a id="jira-notification-settings"></a>Jira Notification Settings<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/settings/notification-settings.asciidoc">edit</a>
</h4>
<p>You can configure the following Jira notification settings in
<code class="literal">elasticsearch.yml</code>. For more information about using notifications
to create issues in Jira, see <a class="xref" href="actions-jira.html#configuring-jira-actions" title="Configuring Jira actions">Configuring Jira actions</a>.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">xpack.notification.jira</code>
</span>
</dt>
<dd>
<p>
Specifies account information for using notifications to create
issues in Jira. You can specify the following Jira account attributes:
</p>
<div class="variablelist">
<a id="jira-account-attributes"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">secure_url</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
The URL of the Jira Software server. Required.
</dd>
<dt>
<span class="term">
<code class="literal">secure_user</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
The name of the user to connect to the Jira Software server. Required.
</dd>
<dt>
<span class="term">
<code class="literal">secure_password</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
The password of the user to connect to the Jira Software server. Required.
</dd>
<dt>
<span class="term">
<code class="literal">issue_defaults</code>
</span>
</dt>
<dd>
Default fields values for the issue created in Jira. See
<a class="xref" href="actions-jira.html#jira-action-attributes" title="Jira action attributes">Jira action attributes</a> for more information.
Optional.
</dd>
</dl>
</div>
</dd>
</dl>
</div>
<h4>
<a id="pagerduty-notification-settings"></a>PagerDuty Notification Settings<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/settings/notification-settings.asciidoc">edit</a>
</h4>
<p>You can configure the following PagerDuty notification settings in
<code class="literal">elasticsearch.yml</code>. For more information about sending notifications
via PagerDuty, see <a class="xref" href="actions-pagerduty.html#configuring-pagerduty-actions" title="Configuring PagerDuty actions">Configuring PagerDuty actions</a>.</p>
<div class="variablelist">
<a id="pagerduty-account-attributes"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">xpack.notification.pagerduty</code>
</span>
</dt>
<dd>
<p>
Specifies account information for sending notifications
via PagerDuty. You can specify the following PagerDuty account attributes:
</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">name</code>
</span>
</dt>
<dd>
A name for the PagerDuty account associated with the API key you
are using to access PagerDuty. Required.
</dd>
<dt>
<span class="term">
<code class="literal">secure_service_api_key</code> (<a class="xref" href="secure-settings.html" title="Secure settings">Secure</a>)
</span>
</dt>
<dd>
The <a href="https://developer.pagerduty.com/documentation/rest/authentication" class="ulink" target="_top">
PagerDuty API key</a> to use to access PagerDuty. Required.
</dd>
</dl>
</div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">event_defaults</code>
</span>
</dt>
<dd>
<p>
Default values for
<a class="xref" href="actions-pagerduty.html#pagerduty-event-trigger-incident-attributes" title="Pagerduty event trigger incident attributes">PagerDuty event attributes</a>.
Optional.
</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">description</code>
</span>
</dt>
<dd>
A string that contains the default description for PagerDuty events.
If no default is configured, each PagerDuty action must specify a
<code class="literal">description</code>.
</dd>
<dt>
<span class="term">
<code class="literal">incident_key</code>
</span>
</dt>
<dd>
A string that contains the default incident key to use when sending
PagerDuty events.
</dd>
<dt>
<span class="term">
<code class="literal">client</code>
</span>
</dt>
<dd>
A string that specifies the default monitoring client.
</dd>
<dt>
<span class="term">
<code class="literal">client_url</code>
</span>
</dt>
<dd>
The URL of the default monitoring client.
</dd>
<dt>
<span class="term">
<code class="literal">event_type</code>
</span>
</dt>
<dd>
The default event type. Valid values: <code class="literal">trigger</code>,<code class="literal">resolve</code>, <code class="literal">acknowledge</code>.
</dd>
<dt>
<span class="term">
<code class="literal">attach_payload</code>
</span>
</dt>
<dd>
Whether or not to provide the watch payload as context for
the event by default. Valid values: <code class="literal">true</code>, <code class="literal">false</code>.
</dd>
</dl>
</div>
</dd>
</dl>
</div>
</dd>
</dl>
</div>
</div>

</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="modules-threadpool.html">« Thread pools</a>
</span>
<span class="next">
<a href="important-settings.html">Important Elasticsearch configuration »</a>
</span>
</div>
</div>

                  <!-- end body -->
                </div>
                <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                  <div id="rtpcontainer" style="display: block;">
                    <div class="mktg-promo">
                      <h3>Most Popular</h3>
                      <ul class="icons">
                        <li class="icon-elasticsearch-white"><a href="https://www.elastic.co/webinars/getting-started-elasticsearch?baymax=default&amp;elektra=docs&amp;storm=top-video">Get Started with Elasticsearch: Video</a></li>
                        <li class="icon-kibana-white"><a href="https://www.elastic.co/webinars/getting-started-kibana?baymax=default&amp;elektra=docs&amp;storm=top-video">Intro to Kibana: Video</a></li>
                        <li class="icon-logstash-white"><a href="https://www.elastic.co/webinars/introduction-elk-stack?baymax=default&amp;elektra=docs&amp;storm=top-video">ELK for Logs &amp; Metrics: Video</a></li>
                      </ul>
                    </div>
                  </div>
                </div>
              </div>
            </div>
          </section>

        </div>


<div id="elastic-footer"></div>
<script src="https://www.elastic.co/elastic-footer.js"></script>
<!-- Footer Section end-->

      </section>
    </div>

<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs.js"></script>
<script type="text/javascript">
  window.initial_state = {}</script>
  </body>
</html>
